DelegationAPI
The Delegation API is a powerful tool designed for managing user delegations within an organization. This API allows for the creation, retrieval, and management of delegation entities, which can define permissions and access rights across different users and resources. By utilizing this API, organizations can streamline the process of granting temporary access, ensuring efficient collaboration and resource management.
Methods
| Name | Description |
|---|---|
| SetUrl(url) | Sets the API URL for requests. |
| Disable(request, telemetryCollectorHolder) | Disables an existing delegation using the provided secret key. This method is used when the delegation needs to be deactivated or revoked. |
| GetTakenDelegations(request, telemetryCollectorHolder) | Retrieves delegations that have been assigned to the current user. This method is used to view the active, passive, or all delegations where the user is the recipient, helping users to understand which tasks or roles have been delegated to them. |
| Get(request, telemetryCollectorHolder) | Retrieves delegation details using the provided secret key. This method is used to fetch the delegation information like scope, positions, and other metadata related to the delegation. |
| GetGivenDelegations(request, telemetryCollectorHolder) | Retrieves delegations that have been given by the current user. This method is typically used to track the active, passive, or all delegations initiated by the user, allowing them to view or manage their delegation assignments. |
| Create(request, telemetryCollectorHolder) | Creates a new delegation based on the given request parameters. The user can delegate certain tasks or access rights to another user by specifying the delegation details, including the scope, the recipient, and the duration of the delegation. |
| Edit(request, telemetryCollectorHolder) | Edits an existing delegation with updated details. This method is used when modifications are required to an already created delegation. |
| Regenerate(request, telemetryCollectorHolder) | Regenerates a delegation using a secret key. This method is typically used when a previously generated delegation needs to be refreshed or a new token/secret is required. |